Comments (4)
I think instructions should help people building modified versions from local repos, not just building from unmodified github.
Clear, I could add a small development chapter in the documentation which would state to use "git clone --recursive" etc and also provide a link to the ISA-L list of build requirements. I could link that from the README.
I don't understand your reluctance to just straightforwardly state the requirements.
That's not an entirely accurate rendition of my position. I do not want to clutter the landing page with very detailed information that is irrelevant to most users. Having said that, your suggestion to provide detailed instructions linked from the README also works for me. I will put this on the to-do list.
from python-isal.
From the installation manual.
The latest development version of python-isal can be installed with:
pip install git+https://github.com/rhpvorderman/python-isal.git
This automatically installs the submodules.
Can you specify what is lacking about not explicitly stating that there are submodules? It is not needed if the listed installation instructions are used.
from python-isal.
I cloned the repo, because it was clear I was going to have to fix something, and ran setup.py. I also, I think, tried to run pip passing the directory. I definitely ended up with a "can't find Makefile.unx" error which was quite mysterious.
I think instructions should help people building modified versions from local repos, not just building from unmodified github.
I don't understand your reluctance to just straightforwardly state the requirements. Having that missing seems like an unnecessary barrier to use and contributions.
I look at a readme to be for people using the source. It seems entirely fine to put installation instructions in INSTALL.md and have only a line or two in readme to say "see INSTALL.md for installation".
from python-isal.
Great, thanks. I do understand the githubby landing page notion, even though I come from an earlier time :-)
from python-isal.
Related Issues (20)
- Release 1.2.0
- Release 1.3.0
- Release 1.4.0
- Release 1.4.1
- Release 1.5.0
- Memory leak in v1.4.0 and newer HOT 4
- Release 1.5.1
- Automatically test for memory leaks using libasan HOT 1
- igzip_threaded.open does not close opened file on error HOT 5
- Release 1.5.2
- igzip_threaded cannot append HOT 4
- Release 1.5.3
- _PyBytes_Join will be removed in 3.13
- IGzipFile should not crash on wrong compression level when opened for reading. HOT 5
- Release 1.6.0
- Release 1.6.1
- Error building wheels for isal HOT 19
- requirement for nasm is not documented in README HOT 1
- READ and WRITE should be inherited from the gzip module.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from python-isal.