mirror of
https://github.com/LaCasemate/fab-manager.git
synced 2025-02-20 14:54:15 +01:00
improved readme and links to documentation
This commit is contained in:
parent
2571e14482
commit
7024c30c6c
41
README.md
41
README.md
@ -10,15 +10,11 @@ Fab-manager is the Fab Lab management solution. It provides a comprehensive, web
|
||||
##### Table of Contents
|
||||
1. [Software stack](#software-stack)
|
||||
2. [Contributing](#contributing)
|
||||
3. [Setup a production environment](#setup-a-production-environment)
|
||||
4. [Setup a development environment](#setup-a-development-environment)
|
||||
5. [Internationalization (i18n)](#i18n)
|
||||
6. [Open Projects](#open-projects)
|
||||
7. [Plugins](#plugins)
|
||||
8. [Single Sign-On](#sso)
|
||||
9. [Known issues](#known-issues)
|
||||
10. [Related Documentation](#related-documentation)
|
||||
|
||||
3. [Documentation](#documentation)
|
||||
4. [Open Projects](#open-projects)
|
||||
5. [Plugins](#plugins)
|
||||
6. [Single Sign-On](#sso)
|
||||
7. [Related Documentation](#related-documentation)
|
||||
|
||||
|
||||
<a name="software-stack"></a>
|
||||
@ -38,26 +34,10 @@ Fab-manager is a Ruby on Rails / AngularJS web application that runs on the foll
|
||||
|
||||
Contributions are welcome. Please read [the contribution guidelines](CONTRIBUTING.md) for more information about the contribution process.
|
||||
|
||||
<a name="setup-a-production-environment"></a>
|
||||
## Setup a production environment
|
||||
<a name="documentation"></a>
|
||||
## Documentation
|
||||
|
||||
To run Fab-manager as a production application, you must follow the procedure described in the [production readme](doc/production_readme.md).
|
||||
This procedure is using [Docker-compose](https://docs.docker.com/compose/overview/) to manage the application and its dependencies.
|
||||
|
||||
<a name="setup-a-development-environment"></a>
|
||||
## Setup a development environment
|
||||
|
||||
In you intend to run Fab-manager on your local machine to contribute to the project development, you can set it up by following the [development readme](doc/development_readme.md).
|
||||
This procedure relies on [Docker-compose](https://docs.docker.com/compose/overview/) to set-up the dependencies.
|
||||
|
||||
Optionally, you can use a virtual development environment that relies on Vagrant and Virtual Box by following the [virtual machine instructions](doc/virtual-machine.md).
|
||||
|
||||
<a name="i18n"></a>
|
||||
## Internationalization (i18n)
|
||||
|
||||
The Fab-manager application can only run in a single language but this language can easily be changed.
|
||||
|
||||
Please refer to the [translation readme](doc/translation_readme.md) for instructions about configuring the language or to contribute to the translation.
|
||||
The full documentation is available at [doc.fab.mn](http://doc.fab.mn).
|
||||
|
||||
<a name="open-projects"></a>
|
||||
## Open Projects
|
||||
@ -102,11 +82,6 @@ Currently, OAuth 2 is the only supported protocol for SSO authentication.
|
||||
|
||||
For an example of how to use configure an SSO in Fab-manager, please read [sso_with_github.md](doc/sso_with_github.md).
|
||||
|
||||
<a name="known-issues"></a>
|
||||
## Known issues
|
||||
|
||||
Before reporting an issue, please check if your issue is not listed in the [know issues](doc/known-issues.md) with its solution.
|
||||
|
||||
<a name="related-documentation"></a>
|
||||
## Related Documentation
|
||||
|
||||
|
@ -72,7 +72,7 @@ verlt() {
|
||||
version_error()
|
||||
{
|
||||
printf "\n\n\e[91m[ ❌ ] You are running Fab-manager version %s\n\e[39m" "${VERSION:-undetermined}"
|
||||
printf "You must upgrade Fab-manager to %s first.\nPlease refer to https://github.com/sleede/fab-manager/blob/master/doc/production_readme.md#update-fab-manager for instructions\n" "$1" 1>&2
|
||||
printf "You must upgrade Fab-manager to %s first.\nPlease refer to http://update.doc.fab.mn for instructions\n" "$1" 1>&2
|
||||
exit 3
|
||||
}
|
||||
|
||||
@ -101,7 +101,7 @@ add_environments()
|
||||
printf "\e[91m::\e[0m \e[1mInserting variable %s..\e[0m.\n" "$ENV"
|
||||
printf "# added on %s\n%s\n" "$(date +%Y-%m-%d\ %R)" "$ENV" >> "config/env"
|
||||
else
|
||||
printf "\e[93m[ ⚠ ] Ignoring invalid option: -e %s.\e[39m\n Given value is not valid environment variable, please see https://huit.re/environment-doc\n" "$ENV"
|
||||
printf "\e[93m[ ⚠ ] Ignoring invalid option: -e %s.\e[39m\n Given value is not valid environment variable, please see http://env.doc.fab.mn\n" "$ENV"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user