Giter VIP home page Giter VIP logo

helptransl8's Introduction

HelpTransl8

HelpTransl8 is a tool for document translators.

Origin of development and its response

The main problem when documentation is translated is maintenance. The original documentation (often in english) evolves. So how do we locate between the version we translated and the latest version?

HelpTransl8 is an answer to this question: each file of the original documentation is kept in a hidden file with the same name. Thus, when updating HelpTransl8 compares the new file with the old one. If the new file is different then it replaces the hidden file and informs the user in a TODO list. If the file does not exist, it is created with its original version!

Installation

macOS

brew brew tap papilip/brew
brew install helptransl8

From source (check dependencies :)

git clone https://github.com/papilip/helptransl8.git && cd helptransl8
crystal build src/helptransl8.cr --release

Quickstart

helptransl8 --init=https://url_original_repository
helptransl8 --check
cat TODO_helptransl8.yml

Usage

  • helptransl8 -c | --check Check each file with the original repository.

  • helptransl8 -h | --help Show help with all commands.

  • helptransl8 -i | --init=url_du_depot_original Generates the helptransl8.yml file with original repository url.

  • helptransl8 -p | --print Print URL from original repository.

  • helptransl8 -v | --version Shows the program version.

Development

  • CRYSTAL_ENV=devel|development|test ./helptransl8 Using the program by initializing the environment.

  • Tests are missing!

Pull Requests welcome !

Contributors

  • Philippe Nénert (@papilip) - Creator, maintainer

helptransl8's People

Contributors

veelenga avatar papilip avatar

Stargazers

Alexander ADAM avatar Andrew Larin avatar Byungjik Roh avatar Igor Zubkov avatar avatar Serdar Dogruyol - Sedo セド avatar

Watchers

avatar James Cloos avatar avatar

Forkers

veelenga

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.