From 9b97934d0a39eb824b39123324e50126e9d300a2 Mon Sep 17 00:00:00 2001 From: Joshua Strobl Date: Sat, 16 Jan 2016 07:40:00 +0200 Subject: [PATCH] Update README with more in-depth TODO, info about Solus Project, further details on licensing. --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 222b3eb..a00bd89 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ -This is the repository of the Solus Project's User Guide. +# User Guide # + +This is the repository of the Solus Project's User Guide. Stumbled on this repo and have no idea what any of this is? Check out the [Solus Project](https://solus-project.com) and our Solus Operating System. + +## TODO ## TODO: -1. Convert existing Doc to Markdown files. -2. Create basic build system that aggregates Markdown files and generates PDFs. +[x] Convert User Guide to Markdown files. -## License ## +[ ] Create build system that aggregates Markdown files, swaps out our custom syntax for HTML, then use the HTML to generate PDFs. + +[ ] Actually document and create consistent custom Markdown syntaxes. + +[ ] Deliver Release 2 of User Guide + +## Licenses ## + +**Build System** + +Files relating to the parsing / build system are licensed under GPL-2.0. For the full text, view LICENSE.txt. + +**Markdown** The Markdown files in this repository are licensed under the Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works. -Non-Markdown files are licensed under GPL-2.0. For the full text, view LICENSE.txt. +**Media Assets** + +- Solus Project logo is owned wholely by Solus Project. +- Non-logo assets are licensed under Creative Commons By-NC-SA 4.0 License. For the full text, view LICENSE-MD.txt. Solus Project is considered the sole rights holder of these works. \ No newline at end of file