Skip to content

Call-for-Code/Repo-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License Community

INSTRUCTIONS: This GitHub repository serves as a template and example you can use to create a well-documented README for your project.

Click the Use this template button to create a new version of this repository and start entering content for your own project. Remove any "INSTRUCTIONS" sections when you are ready to submit your project.

New to Git and GitHub? This free online course will get you up to speed quickly: Getting Started with Git and GitHub.

Replace this heading with your team/submission name

INSTRUCTIONS: Below are the suggested sections to include in your README file to make sure your project is well documented. You can remove this instruction text.

Project summary

The issue we are hoping to solve

REPLACE THIS SENTENCE with a short description, 2-3 sentences in length, of the specific sustainability problem your solution is meant to address.

How our solution can help

REPLACE THIS SENTENCE with a short description of your team's solution, in about 10 words.

How it works

INSTRUCTIONS: Replace this paragraph with a longer description of your solution. In about 500 words, describe your solution in more detail. Include the real-world problem you identified, describe the technological solution you have created, and explain how it’s an improvement over existing solutions. You can supply additional documentation in this source code repository that you link to as well.

More detail is available in our description document.

Technology implementation

Technology used

INSTRUCTIONS: Included here is a list of IBM watsonx products. Remove any products you did not use.

Solution design

REPLACE THIS EXAMPLE WITH YOUR OWN, OR REMOVE THIS EXAMPLE

Diagram and step-by-step description of the flow of our solution:

Video transcription/translaftion app

  1. The user navigates to the site and uploads a video file.
  2. Watson Speech to Text processes the audio and extracts the text.
  3. Watson Translation (optionally) can translate the text to the desired language.
  4. The app stores the translated text as a document within Object Storage.

Install and run this app

Installation

INSTRUCTIONS: List the set of steps for a judge to set up and run your app.

  1. Step 1
  2. Step 2
  3. Step 3

Testing

INSTRUCTIONS: List the set of steps for a judge now test your app.

  1. Step 1
  2. Step 2
  3. Step 3

About

A basic GitHub repository example.

Resources

License

Stars

Watchers

Forks