Add info to a README for docs

This commit is contained in:
Darren Burns
2022-02-07 10:24:50 +00:00
parent 5c2438b585
commit ad8465dafb
2 changed files with 18 additions and 14 deletions

18
docs/README.md Normal file
View File

@@ -0,0 +1,18 @@
# Documentation Workflow
* Ensure you're inside the virtual environment `poetry shell`
* Run the live-reload server using `mkdocs serve`
* Create new pages by adding new Markdown files
## Commands
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.

View File

@@ -9,17 +9,3 @@ Creating a TUI can be challenging. It may be easier to create a GUI or web appli
Textual seeks to lower the difficulty level of building a TUI by borrowing developments from the web world and to a lesser extent desktop applications. The goal is for it to be as easy to develop a TUI for your project as it would be to add a command line interface.
Textual also offers a number of enhancements over traditional TUI applications by taking advantage of improvements to terminal software and the hardware it runs on. Terminals are a far cry from their roots in ancient hardware and dial-up modems, yet much of the software that runs on them hasn't kept pace.
## Commands
- `mkdocs new [dir-name]` - Create a new project.
- `mkdocs serve` - Start the live-reloading docs server.
- `mkdocs build` - Build the documentation site.
- `mkdocs -h` - Print help message and exit.
## Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.