Moved information about using this template to the beginning of the
installation part, added a few more documentation links in it, fixed
some typos.
---------
Signed-off-by: George Araújo <george.gcac@gmail.com>
majority of the recent improvements to al-folio have been truly driven
by a growing community of fans and contributors. this template has
gradually transformed from a low-key weekend project into a "public
good" of some sort used by thousands of people, university labs and
classes, and academic conference and workshops. as such, having personal
sponsorship info from the repository is no longer relevant.
as the community grows a bit further, we may have to think about
establishing some kind of governance around decisions of how al-folio is
supposed to evolve, which features to prioritize, and how to reward
contributors for their hard work. for now, these decisions will be made
by the project maintainers (active contributors are welcome to join the
team). and I'm all ears for proposals and suggestions!
By using this Github action it is possible to keep the derived
repository up-to-date with its template.
I am currently using this to keep my website up to date with the
template repository. An example of the PR this action creates can be
seen [here](https://github.com/george-gca/george-gca.github.io/pull/13).
Signed-off-by: George Araújo <george.gcac@gmail.com>
This PR changes README.md to encourage people to use `Use this template`
rather than `fork`.
### Differences between `Use this template` and fork
> - A new fork includes the entire commit history of the parent
repository, while a repository created from a template starts with a
single commit.
> - Commits to a fork don't appear in your contributions graph, while
commits to a repository created from a template do appear in your
contribution graph.
> - A fork can be a temporary way to contribute code to an existing
project, while creating a repository from a template starts a new
project quickly.
[Ref](https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
### Cons
Possible con would be that it is harder to pull the new changes from
this repo to the users' repos. It does not seem like impossible to do so
but it will require additonal actions on the users end.
- https://github.com/orgs/community/discussions/23528
-
https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository
---------
Co-authored-by: Maruan <alshedivat@users.noreply.github.com>
This file makes it easier for windows users to use docker. (Closes#829)
Previous to this commit, those who used Windows had to install Ubuntu
inside windows (via WSL) and run our commands. Now they can run it by
just typing `docker-compose up`.
> The main problem was that `./bin/dockerhub_run.sh` command was written
with `Bash` in mind and you had to change it a little bit to make it
compatible with windows `Powershell`. We shouldn't have two scripts.
This is why adding a `docker-compose.yml` file is necessary.
[Altmetric](https://www.altmetric.com/) tracks social media and citation
activity for a paper. I added an option to add the altmeric id to a
paper's bib entry, which results in the altmeric badge for the paper
being displayed next to the other buttons. As an example, I added the
altmetric id for the Einstein, Podolsky & Rosen paper.
