STRLCPY/451-CorporateRiskMiner

readme
Marko Sahan committed 2 years ago

97f0c819

Total 1 files

■ ■ ■ ■ ■ ■

README.md

1	+	# Project name
2	+
3	+	## Team Members
4	+	This section is a list of team members, and possibly links to GitHub/GitLab/LinkedIn/personal blog pages for members.
5	+
6	+	## Tool Description
7	+	This sections discusses the purpose and motivation for the tool, and how it addresses a tool need you've identified.
8	+
9	+	## Installation
10	+	This section includes detailed instructions for installing the tool, including any terminal commands that need to be executed and dependencies that need to be installed. Instructions should be understandable by non-technical users (e.g. someone who knows how to open a terminal and run commands, but isn't necessarily a programmer), for example:
11	+
12	+	1. Make sure you have Python version 3.8 or greater installed
13	+
14	+	2. Download the tool's repository using the command:
15	+
16	+	git clone https://github.com/bellingcat/hackathon-submission-template.git
17	+
18	+	3. Move to the tool's directory and install the tool
19	+
20	+	cd hackathon-submission-template
21	+	pip install .
22	+
23	+	## Usage
24	+	This sections includes detailed instructions for using the tool. If the tool has a command-line interface, include common commands and arguments, and some examples of commands and a description of the expected output. If the tool has a graphical user interface or a browser interface, include screenshots and describe a common workflow.
25	+
26	+	## Additional Information
27	+	This section includes any additional information that you want to mention about the tool, including:
28	+	- Potential next steps for the tool (i.e. what you would implement if you had more time)
29	+	- Any limitations of the current implementation of the tool
30	+	- Motivation for design/architecture decisions
31	+

readme