Add docs, usage and examples

.env.example

@@ -0,0 +1,2 @@
+REACT_APP_SHEET_ID=<your_googledrive_spreadsheet_id>
+REACT_APP_SHEET_NAME=<the_deadline_sheet_name_in_the_spreadsheet>

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 CIn-UFPE
+Copyright (c) 2023 CInCoders CIn-UFPE
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,17 @@
 # CS deadlines
 
 Deadlines from the Top Computer Science Conferences!
+
+## Forks, Setup and Usage
+
+You may fork this repository to create your own page with your deadlines!
+For a detailed info on how to setup, how to use this repository and how to set your own deadlines, as well as examples, then refer to our [usage guide](/docs/USAGE.MD).
+
+## Contribution
+
+Contributions are welcome!
+To know a step by step guide on how to contribute refer to our [contribution guide](/docs/CONTRIBUTING.md).
+
+## License
+
+[MIT](LICENSE)

docs/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Welcome to our contributing guide
+
+Thank you for your intentions on evolving our project. Every contribution is welcomed! Show your ❤️ and support by giving a ⭐.
+
+## Getting started
+
+If you just want to submit deadlines information then you may open and issue with your request!
+If you need some help setting up the project to make some changes, or if you want some informations on how to use the repository, please refer to our [usage guide](./USAGE.MD).
+
+### Issues
+
+#### Create a new issue
+
+If you spot a problem on our project try to take a look if any issues for that already exists. If not, you can create a new issue using one of our issue forms.
+
+#### Solve an issue
+
+If you want to contribute to us and solve any issue that you might find interesting, you can look through our issues list. After you've done some work and solved the issue you can open a PR with the fix.
+
+### Pull Requests
+
+When you've finished making some changes to the project and want to contribute to us, you can do so by opening a PR.
+
+- Don't forget to link your PR to an Issue if you solved one.
+- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
+- We may ask for changes to be made before a PR can be merged using pull request comments.
+- As you update your PR and apply changes, mark each conversation as resolved.

docs/USAGE.MD

@@ -0,0 +1,41 @@
+# USAGE
+
+**The files in this folder are just examples and are not used by the system.**
+The system downloads a csv file expecting the structure of [deadlines.csv](./deadlines.csv).
+
+This file is generated automatically based on a google drive spreadsheet using google drive api. The google drive spreadsheet currently used is represented here as the Top CS Deadlines.xlsx.
+
+To use the same spreadsheet in google drive you need to upload the Top CS Deadlines.xlsx to google drive as a google docs spreadsheet and edit with your data.
+
+## Configuration
+
+The google spreadsheet needs to be shared with "Anyone with the link" as viewer to be able to download.
+
+Also you need to configure environment variables (either in the .env file or, if using github pages, in the github variables at the repository settings > Secrets and variables > Actions > variables).
+
+REACT_APP_SHEET_ID=<your_googledrive_spreadsheet_id>
+REACT_APP_SHEET_NAME=<the_deadline_sheet_name_in_the_spreadsheet>
+
+The "REACT_APP_SHEET_ID" is obtained in the spreadsheet link. E.g.: in "https://docs.google.com/spreadsheets/d/12345678901234567890123456789012345678901234/edit" the spreadsheet id is 12345678901234567890123456789012345678901234
+
+## Editing you data
+
+You add or change areas in "Areas" sheet. There is no need to manually input AreaID, it is automatically generated.
+
+In the "Conferences" sheet you change the conferences to be displayed. In this sheet the AreaId and GreatArea are generated automatically based on the choosen area. There is no need to manually input ConferenctID, it is automatically generated.
+
+The "Deadlines" sheet is the one used by the system to display the deadlines. You only need to set the Conference column, then the conference data and area are loaded based on the other sheets. There is no need to manually input DeadlineID, it is automatically generated.
+
+### Deadline sheet columns:
+
+| Column           | Meaning                                                                                                          |
+| ---------------- | ---------------------------------------------------------------------------------------------------------------- |
+| Conference       | The conference name from the "Conferences" sheet                                                                 |
+| DeadlineID       | Automatically generated                                                                                          |
+| Order            | The number of the displayed deadlines when a conference has more than one deadline, starting as 1                |
+| Deadline         | The human readable deadline data                                                                                 |
+| DeadlineTimeZone | The Time Zone of the deadline                                                                                    |
+| DeadlineISO      | The actual deadline data used by cs-deadlines, automatically formated and generated based on the Deadline column |
+| Detail           | Any detail you may display for the specific deadline                                                             |
+
+\*The other columns, for area and conference informations are automatically obtained based on their own sheets and don't need to be manually set.