JoanGiner commited on
Commit
0155ff7
·
1 Parent(s): 2ebedba

fixed normal readme

Browse files
Files changed (1) hide show
  1. README_nonhf.md +42 -0
README_nonhf.md ADDED
@@ -0,0 +1,42 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # The Software Diversity Card webform generator 🏢
2
+
3
+ Welcome to the Software Diversity Card Generator—a form-based application designed to empower you to highlight and promote diversity in software projects. Our innovative tool helps you generate comprehensive diversity cards in both JSON and Markdown formats, offering a transparent overview of the varied teams involved in development and governance, the user groups engaged in testing, and the tailored software adaptations for different social groups. By providing a structured model, an extended JSON syntax, and a toolkit backed by real-world examples, our platform aims to foster inclusive practices that can be embraced by open-source communities, academic journals, and forward-thinking businesses alike.
4
+
5
+
6
+ ## Public demo and other tools
7
+
8
+ We have released a public demo of the web-form generator at: www.dummy.org
9
+
10
+ Do you prefer filling the card using your favourite IDE? Try out the Visual Studio Code language pluguin here: www.vscodemarket.org/ourtool
11
+
12
+
13
+ ## Dependencies
14
+
15
+ It is recommended to use a virtual environment, i.e., the following commands should be run before installing the dependencies:
16
+
17
+ ```console
18
+ python3 -m venv .venv
19
+ source .venv/bin/activate
20
+ ```
21
+
22
+ This project relies on [Streamlit 1.x](https://github.com/streamlit/streamlit). To install the dependencies run:
23
+
24
+ ```console
25
+ pip install -r requirements.txt
26
+ ```
27
+
28
+ ## Running the service
29
+
30
+ After setting up the virtual environment and installing the dependencies, run the following command to start the server:
31
+
32
+ ```console
33
+ streamlit run server.py
34
+ ```
35
+
36
+ The streamlit listening port can be customized by setting the `--server.port` parameter:
37
+
38
+ ```console
39
+ streamlit run server.py --server.port 2000
40
+ ```
41
+
42
+