manual/README.md

# Lubuntu Manual Source Code

This is the Lubuntu Manual source code. The concept was derived from [the Kubuntu Manual](https://github.com/ahoneybun/kubuntu-manual). The master branch of this data is now on LXQt for Lubuntu 18.10+ and if you want code for earlier versions it is on the LXDE branch. 

## How it works

The documentation is powered by [Sphinx](http://www.sphinx-doc.org/en/stable/) and is written in reStructuredText.

Run the following command to install the needed dependencies:

```
sudo apt install python3-pip python3-sphinx texlive-full arcanist && pip3 install sphinx_bootstrap_theme
```

You can see the options for building the documentation by running `make help`.

## Contributing

To contribute to the Lubuntu Manual, you can either create a request on Launchpad, or send patch mail to [lubuntu-devel@lists.ubuntu.com](mailto:lubuntu-devel@lists.ubuntu.com) and prefix the subject with `[Lubuntu Manual Pull Request]`.

If you really want to learn more about sphinx to help Lyn Perrine found this pycon video helpful [Carol_Willing-Practical_Sphinx] (https://www.youtube.com/watch?v=0ROZRNZkPS8)

## License

This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: http://creativecommons.org/licenses/by/4.0/
Add LICENSE and README.md 2016-08-04 10:11:00 -05:00			`# Lubuntu Manual Source Code`

add note master is now LXQt and LXDE is LXDE branch 2018-10-30 12:49:15 -07:00			`This is the Lubuntu Manual source code. The concept was derived from [the Kubuntu Manual](https://github.com/ahoneybun/kubuntu-manual). The master branch of this data is now on LXQt for Lubuntu 18.10+ and if you want code for earlier versions it is on the LXDE branch.`
Add LICENSE and README.md 2016-08-04 10:11:00 -05:00
			`## How it works`

Add what the docs are written in in the README.md 2016-09-25 18:51:44 -05:00			`The documentation is powered by [Sphinx](http://www.sphinx-doc.org/en/stable/) and is written in reStructuredText.`
Add LICENSE and README.md 2016-08-04 10:11:00 -05:00
Add dependencies to README 2016-08-04 21:00:15 -05:00			`Run the following command to install the needed dependencies:`

			```
Fix installation of packages Install package arcanist from Ubuntu repo and not with pip 2018-11-03 18:29:19 +01:00			`sudo apt install python3-pip python3-sphinx texlive-full arcanist && pip3 install sphinx_bootstrap_theme`
Add dependencies to README 2016-08-04 21:00:15 -05:00			```

Add LICENSE and README.md 2016-08-04 10:11:00 -05:00			You can see the options for building the documentation by running `make help`.

			`## Contributing`

remove github after migrating off that and onto launchpad 2018-09-17 19:26:36 -07:00			To contribute to the Lubuntu Manual, you can either create a request on Launchpad, or send patch mail to [lubuntu-devel@lists.ubuntu.com](mailto:lubuntu-devel@lists.ubuntu.com) and prefix the subject with `[Lubuntu Manual Pull Request]`.
Add LICENSE and README.md 2016-08-04 10:11:00 -05:00
Clean up index.rst. 2018-10-14 19:06:21 -05:00			`If you really want to learn more about sphinx to help Lyn Perrine found this pycon video helpful [Carol_Willing-Practical_Sphinx] (https://www.youtube.com/watch?v=0ROZRNZkPS8)`
Add link to really useful video on sphinx from pycon 2018-09-18 12:19:14 -07:00
Add LICENSE and README.md 2016-08-04 10:11:00 -05:00			`## License`

It should be Creative Commons, not GPL. 2018-01-21 20:09:43 -06:00			`This work is licensed under a Creative Commons Attribution 4.0 International License. More details can be found here: http://creativecommons.org/licenses/by/4.0/`