Skip to content

Commit

Permalink
Add more information to the README and change license year (#64)
Browse files Browse the repository at this point in the history
  • Loading branch information
marcelotrevisani authored Feb 27, 2020
1 parent 0474d23 commit c6242c3
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 1 deletion.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Marcelo Duarte Trevisani
Copyright (c) 2021 Marcelo Duarte Trevisani

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,55 @@
![Grayskull](https://comicvine1.cbsistatic.com/uploads/original/4/49448/2661756-castle_grayskull.jpg)

*"Skeleto~~n~~r's main goal is to conquer the mysterious fortress of Castle Grayskull, from which He-Man draws his powers. If he succeeds, Skeletor would be able to conquer not only Eternia, but the whole universe."* Adapted from [Wikipedia](https://en.wikipedia.org/wiki/Skeletor)
-------------
## Introduction

The Grayskull project was created with the intention to eventually replace the
`conda skeleton`. The main goal of this project is to generate concise recipes
for [conda-forge](https://conda-forge.org/).

The current status of ``grayskull`` is generating recipes just looking for ``PyPI``,
but in the future we will expand that to also support to load recipes and also
generate recipes looking for other repositories, such as, CRAN, Conan, etc..

## Installation

It is possible to install this project using `pip`:
```bash
pip install grayskull
```

or `conda`, using the ``conda-forge`` channel:
```bash
conda install -c conda-forge grayskull
```

It is also possible to clone this repo and install it using `pip`:
```bash
git clone https://github.com/marcelotrevisani/grayskull.git
cd grayskull
pip install -e .
```

## Usage

It is pretty simple to use `grayskull`. Just call it, pass the repository
(just `pypi` for now) and the package name.

* Example:
```bash
grayskull pypi pytest
```

After that `grayskull` will create a folder with the same name as the package
and inside of this folder it will generated the recipe (`meta.yaml`).

* Example with `pytest` (`grayskull pypi pytest`):

![Grayskull CLI](docs/images/cli_example_grayskull.gif)


## License
Copyright Marcelo Duarte Trevisani and others, 2020-2021.

Distributed under the terms of the MIT license, grayskull is free and open source software.
Binary file added docs/images/cli_example_grayskull.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c6242c3

Please sign in to comment.