Convert README to Markdown #1506

DylanC · 2018-04-14T18:25:48Z

Its about time OpenShot has a readme in the same style as the rest of GitHub. :)

ferdnyc · 2018-04-21T15:29:16Z

README.md

-#################
-  INSTRUCTIONS
-#################
+## Instructions

 OpenShot Video Editor 2.0 supports Linux, Mac, and Windows. But due to 


Hmm, maybe update all of these "2.0" references? OpenShot hasn't been version 2.0 for years.

I figure they could either say "OpenShot 2" or "OpenShot 2.x" (if the intent is simply to distinguish it from OpenShot 1.x), or else it should be "OpenShot 2.4" at the moment, and we'll have to try and remember to update it each time OpenShot moves to a new minor-version series.

Yeah I was thinking about saying 2.x on it previously. I will make this change.

ferdnyc · 2018-04-21T15:34:36Z

README.md

-https://sourceforge.net/projects/openshotvideo/
-https://www.ohloh.net/p/openshot-video-editor/
+- http://www.openshot.org/  (Official website and blog)
+- http://launchpad.net/openshot/ (source code, bug tracker and translations)


This, um... should point to Github now, surely? (Launchpad was the project's previous home. The README file is included in the source-release tarballs, so it'll be seen by people who haven't necessarily accessed this repo — that's why self-referential links are still useful.)

...Launchpad can still be linked to in addition to Github, of course, the same way Sourceforge is.

Very true. We should be pointing to GitHub now surely.

ferdnyc · 2018-04-21T15:37:33Z

README.md


+You can add a bug here on GitHub but make sure to add plenty of detail about the issue and logs if possible.


Perhaps we should link/reference CONTRIBUTING.md here, for more detailed bug reporting instructions?

Another great suggestion. I agree. Thanks!

Currently I suspect .github/CONTRIBUTING.md won't be included in the source tarballs, which is something we should probably change. (Especially if the README.md makes reference to it. But even if not, I'd say.)

Maybe it's time to move it out of the .github directory, and symlink from there to CONTRIBUTING.md in the repository root? (Or maybe Github will even pick up a CONTRIBUTING file in the root dir, if there isn't one in the .github dir? Lemme see if I can find out how that works...)

Yes! CONTRIBUTING.md can live in any of three places, in fact: the root dir, .github/, or docs/. All of their example projects keep it in the repository root, which I think is smarter than relegating it to .github.

Submitted #1544 to relocate CONTRIBUTING.md.

(Oh, and along the same lines as what I mentioned above about self-referential links, since this file will also — I assume — be included in the OpenShot source tarballs, I'd suggest avoiding language like "here on Github" that assumes the reader... well... is. Here. On Github. They may not be. 😇 )

Perhaps something like "You can file an Issue in the OpenShot/openshot-qt project on Github..." with a link directly to https://github.com/OpenShot/openshot-qt/issues ? (I was first thinking https://github.com/OpenShot/openshot-qt/issues/new which will drop them right at the new-issue form, but really they should be encouraged to search for their issue before filing a duplicate report.)

Grab latest changes

Move contributing file

DylanC · 2018-04-30T14:17:31Z

@ferdnyc - Can you have a look at this again? Its been updated with some of the suggestions.

ferdnyc · 2018-04-30T15:31:54Z

README.md


 Here is a tutorial of the current development features:

-	DO YOU HAVE A HELP MANUAL?
+	Do you have a help manual?


Currently, the heavy indents on the entire Tutorial section are forcing the contents into a <PRE> block (which is what Markdown does when any text is indented by 4 or more spaces, or any tabs), causing it to not wrap, force horizontal scrolling, and generally look... poor.

I'd suggest just pulling out the deep indents and moving everything left so Markdown will auto-format it as a nested list. Or, heck, you could even forget the nesting and use level-4 headers for the "questions" e.g.

#### How do I add media to my project? 1) Drag and drop videos or music files from gnome into the "Project Files" tree. 2) Click the File / Import Files... menu 3) Click the "Import Files" icon on the toolbar (at the top of the screen)

Which formats as:

How do I add media to my project?

Drag and drop videos or music files from gnome into the "Project Files" tree.

Click the File / Import Files... menu

Click the "Import Files" icon on the toolbar (at the top of the screen)

ferdnyc · 2018-04-30T15:34:20Z

README.md

-#################
-
-Documentation for OpenShot 2.0 can be generated with Doxygen, a popular
+Documentation for OpenShot 2.x can be generated with Doxygen, a popular
 command-line application for scanning source code and generating readable
 documentation. OpenShot contains a Doxygen input file (Doxyfile.in), but
 you must first install the following Python filter for Doxygen: doxypy.
 Then, run the following command:

 $ doxygen Doxyfile.in


All of the example command lines need to be enclosed in code blocks, which is probably most readable (in the non-formatted source) if it's done by indenting each line four spaces.

ferdnyc · 2018-04-30T15:34:33Z

README.md

@@ -65,18 +51,13 @@ dependencies in order to run OpenShot successfully:
 4) FFmpeg or Libav (http://www.ffmpeg.org/ or http://libav.org/)
 5) GCC build tools (or MinGW on Windows)

-
-
 To run OpenShot from the command line, use the following syntax:
 (be sure the change the path to match the install location of OpenShot)

 $ cd /home/USER/openshot_qt


ferdnyc · 2018-04-30T15:36:42Z

README.md

-#################
-  HOW TO INSTALL
-#################
+## How to install

 If you would like to install OpenShot, use this command:



Here too, on the next line down. (For some reason I can't add a comment there.)

ferdnyc · 2018-04-30T15:43:13Z

README.md

-#################
-    COPYRIGHT
-#################
+## Copyright


Level-2 headings can also be created in Markdown by underlining the text with a row of hyphens. (A row of = signs will produce H1 headings.) I wonder if that might not make them "stand out" more in the source text file? The text can even be indented (up to 3 spaces). These will all produce the same H2-level "Copyright" heading:

## Copyright Copyright --------- Copyright ---------------

Copyright

ferdnyc · 2018-04-30T15:54:55Z

README.md


+If you would like to help reporting issues or commit fixes to the project please see our guidelines:
+https://github.com/OpenShot/openshot-qt/blob/master/CONTRIBUTING.md


Another option, rather than giving a URL here (and forcing people to the web): Markdown supports relative links, so you could write something like,

If you would like to help reporting issues or commit fixes to the project please see our [contributor guidelines](CONTRIBUTING.md).

It'll be a link to the (local) file in the rendered Markdown, and they'll see the filename if they're reading the source.

ferdnyc · 2018-04-30T15:56:50Z

I think that's it, mostly minor formatting tweaks. Looks good!

DylanC · 2018-05-01T07:40:49Z

@ferdnyc - Updated it again. I just had trouble setting the code tags for the command under:
The audio / video is out of sync. What can I do?
The formatting was not taking affect for some reason.

DylanC · 2018-05-01T08:17:16Z

@ferdnyc - I think you seem happy enough with this and I am too. I feel its good to merge and further updates can be submitted via a new PR.

ferdnyc · 2018-05-01T08:18:36Z

I just had trouble setting the code tags for the command under:
The audio / video is out of sync. What can I do?
The formatting was not taking affect for some reason.

Yeah, you just need to insert a blank line before the indented block, and because it's a subelement of the list item, it needs to be indented seven spaces. (3 for the list + 4 for the code block)

ferdnyc · 2018-05-01T08:19:54Z

I'd also rewrap it, to avoid horizontal scrolling. I'll submit a quick PR to fix that little piece.

DylanC · 2018-05-01T08:21:03Z

@ferdnyc - Thanks! That would be great! :)

DylanC added 4 commits April 14, 2018 18:11

Change readme to be markdown

356b476

Update websites section and removal of too many caps

495c327

Add image preview

7a12480

Take out the preview. Looks better without it.

3fbb038

ferdnyc reviewed Apr 21, 2018

View reviewed changes

DylanC added 4 commits April 30, 2018 14:55

Merge pull request #2 from OpenShot/master

e23a2b2

Grab latest changes

Update GitHub info

6450352

Merge pull request #3 from OpenShot/master

69a1c0b

Move contributing file

Add Contributing section

0e3e38a

ferdnyc reviewed Apr 30, 2018

View reviewed changes

ferdnyc mentioned this pull request Apr 30, 2018

SVG files not rendered properly #1081

Closed

Update Tutorial, Code tags and contrib link

5b1d847

DylanC merged commit 6ffab07 into OpenShot:master May 1, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert README to Markdown #1506

Convert README to Markdown #1506

DylanC commented Apr 14, 2018 •

edited

Loading

ferdnyc Apr 21, 2018

DylanC Apr 28, 2018

ferdnyc Apr 21, 2018

DylanC Apr 28, 2018

ferdnyc Apr 21, 2018 •

edited

Loading

DylanC Apr 28, 2018

ferdnyc Apr 28, 2018 •

edited

Loading

ferdnyc Apr 28, 2018

ferdnyc Apr 28, 2018

ferdnyc Apr 28, 2018

DylanC commented Apr 30, 2018

ferdnyc Apr 30, 2018 •

edited

Loading

ferdnyc Apr 30, 2018

ferdnyc Apr 30, 2018

ferdnyc Apr 30, 2018

ferdnyc Apr 30, 2018 •

edited

Loading

ferdnyc Apr 30, 2018

ferdnyc commented Apr 30, 2018

DylanC commented May 1, 2018

DylanC commented May 1, 2018

ferdnyc commented May 1, 2018

ferdnyc commented May 1, 2018

DylanC commented May 1, 2018


		You can add a bug here on GitHub but make sure to add plenty of detail about the issue and logs if possible.


		If you would like to help reporting issues or commit fixes to the project please see our guidelines:
		https://github.com/OpenShot/openshot-qt/blob/master/CONTRIBUTING.md

Convert README to Markdown #1506

Convert README to Markdown #1506

Conversation

DylanC commented Apr 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ferdnyc Apr 21, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ferdnyc Apr 28, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DylanC commented Apr 30, 2018

ferdnyc Apr 30, 2018 • edited Loading

Choose a reason for hiding this comment

How do I add media to my project?

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ferdnyc Apr 30, 2018 • edited Loading

Choose a reason for hiding this comment

Copyright

Choose a reason for hiding this comment

ferdnyc commented Apr 30, 2018

DylanC commented May 1, 2018

DylanC commented May 1, 2018

ferdnyc commented May 1, 2018

ferdnyc commented May 1, 2018

DylanC commented May 1, 2018

DylanC commented Apr 14, 2018 •

edited

Loading

ferdnyc Apr 21, 2018 •

edited

Loading

ferdnyc Apr 28, 2018 •

edited

Loading

ferdnyc Apr 30, 2018 •

edited

Loading

ferdnyc Apr 30, 2018 •

edited

Loading