Code Monkey home page Code Monkey logo

scratch's Introduction

Scratch

This a a space for me to play around with Docbook & Oxygen.

Project Title

It's a scratch workspace. There's nothing much to describe because there is nothing important here.

Getting Started

It's a repo on Github. Configure a Github account, install and configure Git. Clone it, edit the files. Add them, commit them, push them back. That is about it.

Prerequisites

Since it's not really software, there aren't many pre-requisities.

Git
A Github account
A text editor, such as Xed from the Mint X-Apps.
A tool to compile Docbook into something more readable, such as Publican or DAPS.

Installing

What is to install? These are text files, not code.

Choose a text editor you like and can work with.
This should be something friendly and powerful. Or, alternatively, Vi or Emacs.

If you don't want to muck around with Git, you could just use a web browser and download it.

Running the tests

There are no tests. Can you read it? Yes. Good, you're done. Can you read? No? We suggest you try 9gag or Imgur then.

Break down into end to end tests

English, motherfreaker. Do you speak it?

Jules from "Pulp Fiction". He's a good example, and he's not even real.

And coding style tests

The Readme is in Markdown. The rest is in Docbook, which is a kind of XML. Don't ask. If you don't know, you won't like it.

<?xml version="1.0" encoding="UTF-8"?>
<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbook.rng" type="xml"?>
<article xmlns="http://docbook.org/ns/docbook"
    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
    <info>
        <title>Article Template Title</title>
        <author>
            <orgname>Organization Name</orgname>
            <address>
                <city>City</city>
                <street>Street</street>
                <postcode>000000</postcode>
                <country>Country</country>
            </address>
            <email>[email protected]</email>
        </author>
    </info>
    <sect1>
        <title>Section1 Title</title>
        <subtitle>Section1 Subtitle</subtitle>
        <para>Text</para>
    </sect1>
</article>

I told you you wouldn't like it.

Deployment

Best not, eh?

Built With

  • Xed - A simple-ish text editor with actual menus.
  • oXygen/ - A semi-WYSIWYG XML editor.
  • DAPS - Used to ``compile'' Docbook to PDF & other formats.
  • Dillinger -- online Markdown editor. Nifty.

Contributing

You probably can't, but cash donations or winning lottery tickets are welcome.

Versioning

Version 0.01 - Replace Github's near-empty file with some boilerplate text.

Version 0.02 - Fix: replace "Githib" with actual website name. Test Dillinger editor.

Version 0.03 - Fix errors, typos & layout introduced with Dillinger. You know how it is.

Version 0.04 - This is actually turning into a real revision history. Well I never.

Authors

License

This project is licensed under the Lil License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose material was used.

scratch's People

Contributors

tbazant avatar

Watchers

Liam Proven avatar

Forkers

tbazant

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.