Remove travis, Procfile & PyCharm files, update README outdated infos

certsocietegenerale · Aug 6, 2024 · ff199e0 · ff199e0
1 parent 9358f72
commit ff199e0
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 95 deletions.
diff --git a/.env b/.env
diff --git a/.idea/runConfigurations/manage_py_runserver.xml b/.idea/runConfigurations/manage_py_runserver.xml
diff --git a/.travis.yml b/.travis.yml
diff --git a/Procfile b/Procfile
diff --git a/README.md b/README.md
@@ -13,27 +13,12 @@ See the wiki for the [user manual](https://github.com/certsocietegenerale/FIR/wi
 
 # Installation
 
-There are two ways to install FIR. If you want to take it for a test-drive, just follow the instructions for [setting up a development environment](https://github.com/certsocietegenerale/FIR/wiki/Setting-up-a-development-environment) in the Wiki.
+There are two ways to install FIR. If you want to take it for a test-drive, you can run FIR [using docker](https://github.com/certsocietegenerale/FIR/tree/master/docker)
 
 If you like it and want to set it up for production, [here's how to do it](https://github.com/certsocietegenerale/FIR/wiki/Installation-on-a-production-environment).
 
-A dockerfile for running a dev-quality FIR setup is also available in [docker/Dockerfile](docker/Dockerfile).
-
-Deploy to [Heroku](https://heroku.com) via fir/heroku_settings.py
-
-# Community
-
-A dedicated users mailing list is available https://groups.google.com/d/forum/fir-users
-
 # Technical specs
 
 FIR is written in Python (but you probably already knew that), using Django. It uses Bootstrap and some Ajax and d3js to make it pretty. We use it with a MySQL back-end, but feel free to use any other DB adaptor you might want - as long as it's compatible with Django, you shouldn't run into any major issues.
 
-FIR is not greedy performance-wise. It will run smoothly on a Ubuntu 14.04 virtual machine with 1 core, a 40 GB disk and 1 GB RAM.
-
-# Roadmap
-
-* Nested Todos
-* REST API
-* Mailman
-* You name it :)
+FIR is not greedy performance-wise. It will run smoothly on an Ubuntu virtual machine with 1 core, a 40 GB disk and 1 GB RAM.
diff --git a/docker/README.md b/docker/README.md
@@ -1,14 +1,18 @@
 # Quick Start
 
+You can run FIR on your device with 4 simple commands:
+
 ```
+git clone https://github.com/certsocietegenerale/FIR.git
+cd FIR/docker
 docker-compose build
 docker-compose up -d
 ```
 
-Browse to http://localhost and log in with default credentials admin:admin or dev:dev
+Then browse to http://localhost and log in with default credentials admin:admin or dev:dev
 
 Enjoy!
 
 # Customization. 
 
-If you need to change settings related to mysql or redis, you can edit fir.env file and set accordingly. These environments variable are provided to the container and used in composeprod.py file which corresponds to the default settings for django
+If you need to change settings related to mysql or redis, you can edit fir.env file and set accordingly. These environments variable are provided to the container and used in composeprod.py file which corresponds to the default settings for django
diff --git a/runtime.txt b/runtime.txt