Code Monkey home page Code Monkey logo

Comments (10)

dak180 avatar dak180 commented on June 3, 2024

What sort of examples would you like to see? (I assume you mean for this to be something added to the man page.)

As for the repo layout do you have any specific suggestions?

If you look at what gets wrapped into the tarball created with make dist it should be fairly clear what is needed for packaging; if you still have questions about that, any specifics you can point to would be most helpful.

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

Actually something to read from the web, not the man page. Command and result.

http://sourceforge.net/apps/trac/aria2/wiki/UsageExample

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

Sorry. I didn't get the purpose of this tool. I thought it can be used to fetch the latest revision. Something like this - https://gist.github.com/techtonik/1202091

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

For repository layout I'd move autorevision.sh into src/. mkexamp.sh, control somewhere of of the root. NEWS rename to doc/CHANGES.md . autorevision.asciidoc, logo.svg and CONTRIBUTING.md moved into docs/. COPYING.md renamed into LICENSE.md (COPYING is usually associated with GPL projects even if it is not true).

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

So, the root is README, Makefile and LICENSE. Everything a person needs to get impression of the project. Otherwise he is lost.

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

And README description can also be improved.

- A program for extracting version information useful in release/build scripting from repositories.
+ Shell script to extract info about repository revision and format it for different purposes. 

from autorevision.

dak180 avatar dak180 commented on June 3, 2024

Actually something to read from the web, not the man page. Command and result.

Does http://www.catb.org/esr/autorevision/autorevision.html (an html rendering of autorevision.asciidoc) give you what you want as far as usage instructions?
Unfortunately github seems to leave out the first two sections of the file when rendering it.

from autorevision.

dak180 avatar dak180 commented on June 3, 2024

For repository layout I'd move autorevision.sh into src/. mkexamp.sh, control somewhere of of the root. NEWS rename to doc/CHANGES.md. autorevision.asciidoc, logo.svg and CONTRIBUTING.md moved into docs/. COPYING.md renamed into LICENSE.md (COPYING is usually associated with GPL projects even if it is not true).

Some of the layout and file names are dictated by the shipper tool that we use.

NEWS and control for example are both fixed in name and location because of this.

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

Man page doesn't have any examples of how end result looks like. Only after browsing examples/ folder I've got it.

It would be more clear if term Symbol is replaced with term template variable.

The shipper tool is called from make, and it is open source and seems maintained. I don't see any problems to patch it to use custom control path.

from autorevision.

techtonik avatar techtonik commented on June 3, 2024

And it would be nice if man page backlinked to source repository.

from autorevision.

Related Issues (17)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.