Thread: What software to use to write off line directions?

  1. #1
    Registered User
    Join Date
    May 2009
    Posts
    3,384

    What software to use to write off line directions?

    I am a embedded programmer on a project; and, I have decided that I need to write directions on how to setup the development environment.

    It uses Windows 7 32 bit or 64 bit as the OS the toolchain runs under.
    About a decade past, I would have used RichText files (RTF) to do the documentation; but, I was wondering if there is a better FLOSS or free (no cost) option.

    If RTF is still the best; what editor to use?

    What format is best for the images mainly from screen shots?
    png etc.

    Tim S.
    Last edited by stahta01; 2 Weeks Ago at 01:48 PM. Reason: grammar
    "...a computer is a stupid machine with the ability to do incredibly smart things, while computer programmers are smart people with the ability to do incredibly stupid things. They are,in short, a perfect match.." Bill Bryson

  2. #2
    misoturbutc Hodor's Avatar
    Join Date
    Nov 2013
    Posts
    1,333
    Why not use Doxygen and choose your output (https://www.stack.nl/~dimitri/doxygen/manual/output.html)?

  3. #3
    Registered User
    Join Date
    May 2009
    Posts
    3,384
    Quote Originally Posted by Hodor View Post
    Why not use Doxygen and choose your output (404 Requested URL not found
    Because it is *not* possible!

    This is directions to do things like installing Git and checking out the repos.

    Tim S.
    "...a computer is a stupid machine with the ability to do incredibly smart things, while computer programmers are smart people with the ability to do incredibly stupid things. They are,in short, a perfect match.." Bill Bryson

  4. #4
    and the hat of int overfl Salem's Avatar
    Join Date
    Aug 2001
    Location
    The edge of the known universe
    Posts
    36,370
    LibreOffice or OpenOffice are good choices for creating documentation, and can directly output PDF for publishing.
    If you dance barefoot on the broken glass of undefined behaviour, you've got to expect the occasional cut.
    If at first you don't succeed, try writing your phone number on the exam paper.

  5. #5
    misoturbutc Hodor's Avatar
    Join Date
    Nov 2013
    Posts
    1,333
    Quote Originally Posted by stahta01 View Post
    Because it is *not* possible!

    This is directions to do things like installing Git and checking out the repos.

    Tim S.
    Of course it's possible. You don't have the "comments" in source code ya know (doxygen can use many sources for its information and comments in source files is just one)

  6. #6
    Registered User
    Join Date
    May 2009
    Posts
    3,384
    Quote Originally Posted by Hodor View Post
    Of course it's possible. You don't have the "comments" in source code ya know (doxygen can use many sources for its information and comments in source files is just one)
    OK, I learned something new.

    Tim S.
    "...a computer is a stupid machine with the ability to do incredibly smart things, while computer programmers are smart people with the ability to do incredibly stupid things. They are,in short, a perfect match.." Bill Bryson

  7. #7
    Registered User
    Join Date
    May 2009
    Posts
    3,384
    Code:
    software that was suggested or found via wiki links
      AbiWord
      AntiWord
      Docbook
      doxygen
      LibreOffice
      LinuxDoc
      OpenOffice
    Code:
    output formats that sound useful to have
      HTML
      RTF
      markdown
      PDF
    Thank you all for the input; now to firm up my needs and start deciding which to use/test.

    Tim S.
    "...a computer is a stupid machine with the ability to do incredibly smart things, while computer programmers are smart people with the ability to do incredibly stupid things. They are,in short, a perfect match.." Bill Bryson

  8. #8
    Registered User
    Join Date
    May 2009
    Posts
    3,384
    I have decided to try OpenOffice in the idea I will see if it works and what features are needed.

    Long term I am thinking of trying Docbook and/or doxygen; but, for my current needs those likely have a too long learning curve.

    Tim S.
    Last edited by stahta01; 2 Weeks Ago at 07:00 AM. Reason: grammar
    "...a computer is a stupid machine with the ability to do incredibly smart things, while computer programmers are smart people with the ability to do incredibly stupid things. They are,in short, a perfect match.." Bill Bryson

Popular pages Recent additions subscribe to a feed

Similar Threads

  1. Replies: 1
    Last Post: 04-13-2011, 01:15 PM
  2. Read text file line by line and write lines to other files
    By magische_vogel in forum C Programming
    Replies: 10
    Last Post: 01-23-2011, 10:51 AM
  3. I need directions
    By JacobN in forum C++ Programming
    Replies: 5
    Last Post: 09-26-2008, 07:22 AM
  4. What software is needed to write internet based gaming programs
    By grumpomatic in forum Game Programming
    Replies: 8
    Last Post: 11-26-2005, 10:49 PM
  5. Is it possible to write commercial software?
    By Puddin in forum C++ Programming
    Replies: 13
    Last Post: 03-21-2002, 08:17 PM

Tags for this Thread