-
Notifications
You must be signed in to change notification settings - Fork 5
/
params.json
6 lines (6 loc) · 3.79 KB
/
params.json
1
2
3
4
5
6
{
"name": "Emmeth",
"tagline": "A free, open source bible software.",
"body": "# About Emmeth\r\n>Emmeth = Hebrew for truth.\r\n>Then you will know the truth, and the truth will set you free. (John 8:32 NIV)\r\n\r\n## Vision\r\nEmmeth is a free, open source bible software.\r\nIt's purpose is to be free, easy to use.\r\nIt supports sermon preparation, daily bible reading, studying, scientific use.\r\nIt is multi platform (Windows, Mac, Linux), has a webapp and mobile versions.\r\n\r\n## How it works\r\nThe bible software comes for free. You can either download the source and compile it or download a stable build for your operating system.\r\nEmmeth has a base software which comes for free all the functions are free of use.\r\nTo use it, you need to download in (the base software included) bookstore. \r\nYou need to have an account to download books from the bookstore.\r\nDownloading books is restricted and you need sometimes to purchase the books in order to download them. This is due because of licenses from the authors and the publishers.\r\nSome books are for free, if they are in public domain or under free to use licenses.\r\nEmmeth wants to honor the work of others and respects licenses.\r\nThe books, notes and anything else will be synced to your online account.\r\nThe purchase can be made through the bookstore and the files will be downloaded and synced automatically.\r\n\r\n## Version history\r\n**0.0.1 unstable, pre-alpha**\r\nStill in development, a lot of stuff needs to be done.\r\nIt can be forked and added to.\r\n\r\n## Documentation\r\nFor developers see more in the doc folder.\r\nYou can also look at the documentation at the website.\r\nThe desktop version is coded in qt for multi platform purpose.\r\n\r\n## Compiling from source\r\n\r\n### Download from github\r\n\r\nDownload the zip file of the entire folder.\r\nOR\r\nClone in Desktop if yo have the github sotware installed.\r\nOR\r\nClone using command line.\r\ngit clone [email protected]:bsesic/Emmeth.git\r\n\r\n### using QT\r\nThere is a QT .pro file in the src folder, called Emmeth.pro in qEmmeth.\r\nLoad it and configure your kits.\r\nMake sure you compile into build or test folder (preferred).\r\n\r\n### command line\r\nNeeds qmake (from MinGW). Make sure the path is configured correctly.\r\ncd src/qEmmeth\r\nqmake qEmmeth.pro\r\nmake\r\nmake install\r\n\r\n## Folder structure\r\nbuild - compiled files. Builds for Windows, Mac & Linux go here, stable and nightly.\r\ndocs - documentation (mostly developer stuff)\r\nsrc - source files, also assets, graphics, etc.\r\ntest - compiled files used to test development build.\r\ntools - tools for writing, editing, compiling, which is not part of the base system (mostly python). Also plugins.\r\n\r\n## Contributing\r\nYou like the project?\r\nDo you want to contribute to?\r\nThere are many ways to contribute.\r\n1. Code the base software.\r\n2. Code a mobile app for ios or android.\r\n3. Translate the software into your language.\r\n4. Code the web app.\r\n5. Contribute bibles, dictionaries, lexicons, books, maps, images and other stuff.\r\n6. Testing software and reporting bugs.\r\n\r\n## Tasks\r\n[ ] translating\r\n[ ] webapp (based on laravel)\r\n[ ] API\r\n[ ] IOS app\r\n[ ] Android app\r\n\r\n## Developer(s)\r\nLead programmer:\r\nBenjamin Schnabel\r\nTuebingen, Germany\r\n\r\n## License\r\nThe base software is licensed under the GPL 3 License.\r\nSee more here:\r\nhttp://www.gnu.org/licenses/gpl-3.0-standalone.html\r\nThe bibles, books, dictionaries, maps, lexicons and other stuff is not part of the base program and are under the restrictions and licenes of the various authors and publishers.\r\nSee more on the website.\r\n\r\n## Contact\r\nWebsite: http://www.emmeth.com\r\nEmail: [email protected]\r\n",
"note": "Don't delete this file! It's used internally to help with page regeneration."
}