New documentation

First commit, halfway through a major restructuring of documentation.
This commit is contained in:
Julian Molina committed 2020-02-01 11:25:36 +01:00
1 parent f2ff0ce58b
commit c2fb254a04
456 files changed
+44176 -253

No files matched your search

+11 -5
View File
@@ -4,15 +4,21 @@ The Superalgos Platform provides a visual environment for developing, testing an
![Illustration](https://user-images.githubusercontent.com/13994516/63528460-4550ae80-c503-11e9-8db6-22995e0b9c16.gif)
## Users Manual
## Documentation
Visit the [Users Manual](https://github.com/Superalgos/Platform/wiki) for instructions on how to download, install, fire up and use the app.
The [Users Manual](https://github.com/Superalgos/Platform/wiki) in this repository's wiki features the documentation corresponding to the latest release.
## Code and Development Environment
The ```docs``` folder in this branch features the source files for a new [Jekyll](https://jekyllrb.com/) documentation site to be deployed along with the next release. The new version of the documentation is undergoing a massive restructuring, therefore, it may currently be inconsistent or hard to follow.
The Superalgos Platform draws code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams.
To deploy the new documentation site in your local machine, run [Jekyll](https://jekyllrb.com/docs/) from the ```docs``` folder.
The concerned code is distributed with the app's release and constitutes a fully functional development environment right out of the package. The app runs uncompilled on the actual code.
## Codebase and Development Environment
To build each release, the Superalgos Platform used to draw code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. This has changed.
The ```develop``` branch in this repository now features the latest codebase and development environment.
The codebase is distributed with the platform's release, and constitutes a fully functional development environment right out of the package. The platform runs uncompilled on the actual code (```node run``` from the root folder).
## Contributing