https://github.com/mr-c/shouldacite

Should you cite this software?
https://github.com/mr-c/shouldacite

Last synced: 17 days ago
JSON representation

Should you cite this software?

• Host: GitHub
• URL: https://github.com/mr-c/shouldacite
• Owner: mr-c
• License: other
• Created: 2016-03-23T08:55:06.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2020-07-02T10:24:08.000Z (over 4 years ago)
• Last Synced: 2024-10-17T14:24:41.199Z (27 days ago)
• Language: CSS
• Homepage: http://bit.ly/shouldacite
• Size: 7.44 MB
• Stars: 30
• Watchers: 11
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Citation: CITATION

Awesome Lists containing this project

README

        
# ShouldaCite

[![DOI](https://zenodo.org/badge/54544657.svg)](https://zenodo.org/badge/latestdoi/54544657)

You are writing up your research and wonder if you should cite a particular software package that you used.

[Should you cite this particular piece of software?](should-I-cite-this-software.md)

http://bit.ly/shouldacite

# Web page

* To generate a webpage you need to install `flask`, `markdown`, `frozen-flask`

and `ghp-import`. You can use Conda to get everything needed:

    ```bash

    conda env create -f app/environment.yml

    source activate shouldicite

    ```

* To serve the app type:

    ```bash

    make serve

    ```

    and point your browser to http://0.0.0.0:5000.

* To genearet a static HTML version type:

    ```bash

    make html

    ```

* And finally to publish the content on github pages type:

    ```bash

    make publish

    ```

# License

[![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)

This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).