diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6862869 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,13 @@ +# Contributor Code of Conduct + +## Version 1.0 + +As contributors and maintainers of the TalkControl organisation, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. + +Communication through any of TalkControl's channels (GitHub, Gitter, IRC, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. + +We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to TalkControl projects to do the same. + +If any member of the community violates this code of conduct, the maintainers of the TalkControl organisation may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. + +If you are subject to or witness unacceptable behavior, or have any other concerns, please contact us. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..80766a1 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,39 @@ +In order to run the project locally, you will need these tools: + +# Tools + +**NVM** : https://github.com/creationix/nvm + +> Using nvm, install node 20.x.x + +# Commit + +Please respect theses guidlines when contributing with commits : https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit + +Summary: + +``` +(): + │ │ │ + │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. + │ │ + │ └─⫸ Commit Scope: common|core|theme + │ + └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test|chore +``` + +# Run Locally + +To run the project: + +1. run `nvm use` if you have nvm installed +2. run `npm ci` +3. run `npm start` + +# Deploy + +For the moment, there is no deployment. But when it will be available, you will use `npm run release` + +## Errors + +If you got a "System limit for number of file watchers reached" error , take a look at this solution : [StackOverFlow Watching Error](https://stackoverflow.com/questions/16748737/grunt-watch-error-waiting-fatal-error-watch-enospc/17437601#17437601) diff --git a/README.md b/README.md index 0f78d43..a36a651 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # Talk-Control-RevealJS-Extensions - +

+ TalkControl Logo +

+ +

+ Build Status + License +

+ +## About TalkControl + +TalkControl aims to provides an easy to use extensions for anyone wanted to create slides with [reveal.js](https://github.com/hakimel/reveal.js).